Scripting > CxNote > Note Object > Note Methods

Note Methods

The Note object contains the following methods:

GetAttributeField

The GetAttributeField method returns the string value of a specified note attribute field. Limit of 20 characters. Valid field integers are 1 - 5.

Syntax

GetAttributeField(Field As Integer) As String

Parameters

Parameter Description

Field

Specifies the integer that corresponds to the note attribute field that contains the desired value.

Return Values

This method returns the string value of a specified note attribute field.

Back to top

GetTableField

The GetTableField method returns the string value of a specified note table attribute field by referencing a TRS table entry. Limit of 10 characters. Valid field integers are 1 - 5.

Syntax

GetTableField(Field As Integer) As String

Parameters

Parameter Description

Field

Specifies the integer that corresponds to the note table attribute field that contains the desired value.

Return Values

This method returns the string value of a specified note table attribute field.

Back to top

GetYesNoField

The GetYesNoField method returns the string value of a specified note yes/no attribute field. Valid field integers are 1 - 5.

Syntax

GetYesNoField(Field As Integer) As Boolean

Parameters

Parameter Description

Field

Specifies the integer that corresponds to the note yes/no attribute field that contains the desired value.

Return Values

This method returns the Boolean value of a specified note yes/no attribute field.

Back to top

SetAttributeField

The SetAttributeField method sets the value of a note attribute field.

Syntax

SetAttributeField(Field As Integer, Attr As String)

Parameters

Parameter Description

Field

Specifies the integer that corresponds to the note attribute field that will contain the value specified by the Attr parameter. Valid field integers are 1 - 5.

Attr

Specifies the string value to insert into the note attribute field specified by the Field parameter. Limit of 20 characters.

Return Values

This method has no return value.

Back to top

SetTableField

The SetTableField method sets the value of a note table attribute field.

Syntax

SetTableField(Field As Integer, Table As String)

Parameters

Parameter Description

Field

Specifies an integer that corresponds to a note table attribute field. Valid field integers are 1 - 5.

Table

Specifies a string value to insert into the note table attribute field specified by the Field parameter. The value corresponds to a table entry in the TRS.

Return Values

This method has no return value.

Back to top

SetTbd

The SetTbd method sets the end time for a note to an undetermined future date and time.

Syntax

SetTbd()

Return Values

This method has no return value.

Back to top

SetYesNoField

The SetYesNoField method sets the value of a note yes/no attribute field.

Syntax

SetYesNoField(Field As Integer, YesNo As Boolean)

Parameters

Parameter Description

Field

Specifies the integer that corresponds to the note yes/no attribute field that will contain specified by the YesNo parameter. Valid field integers are 1 - 5.

YesNo

Specifies the Boolean value (True or False) to insert into the note yes/no attribute field specified by the Field parameter.

Return Values

This method has no return value.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.